<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GrPPI: pipeline.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GrPPI
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Generic and Reusable Parallel Pattern Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">pipeline.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="pipeline_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2018 Universidad Carlos III de Madrid</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef GRPPI_PIPELINE_H</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define GRPPI_PIPELINE_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="callable__traits_8h.html">common/callable_traits.h</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="execution__traits_8h.html">common/execution_traits.h</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="pipeline__pattern_8h.html">common/pipeline_pattern.h</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrppi.html">grppi</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Execution, <span class="keyword">typename</span> Generator, <span class="keyword">typename</span> ... Transformers,</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;          requires_execution_supported&lt;std::decay_t&lt;Execution&gt;&gt; = 0&gt;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__pipeline__pattern.html#gaf3942c499118a951617b95c4ee10a502">   46</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__pipeline__pattern.html#gaf3942c499118a951617b95c4ee10a502">pipeline</a>(</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keyword">const</span> Execution &amp; ex, </div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    Generator &amp;&amp; generate_op, </div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    Transformers &amp;&amp; ... transform_ops) </div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;{</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  static_assert(<a class="code" href="namespacegrppi.html#ab781a9381060f18e9e5155a496e71aee">supports_pipeline</a>&lt;std::decay_t&lt;Execution&gt;&gt;(),</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;      <span class="stringliteral">&quot;pipeline pattern is not supported by execution type&quot;</span>);</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  ex.pipeline(std::forward&lt;Generator&gt;(generate_op),</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;      std::forward&lt;Transformers&gt;(transform_ops)...);</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;}</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Transformer, <span class="keyword">typename</span> ... Transformers,</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;          requires_execution_not_supported&lt;std::decay_t&lt;Transformer&gt;&gt; = 0&gt;</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="group__pipeline__pattern.html#ga9486a11d1bca1302bfc4af9a62e4c2eb">   69</a></span>&#160;<span class="keyword">auto</span> <a class="code" href="group__pipeline__pattern.html#gaf3942c499118a951617b95c4ee10a502">pipeline</a>(</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    Transformer &amp;&amp; transform_op,</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    Transformers &amp;&amp; ... transform_ops)</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;{</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="classgrppi_1_1pipeline__t.html">pipeline_t</a>&lt;Transformer, Transformers...&gt;(</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        std::forward&lt;Transformer&gt;(transform_op),</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        std::forward&lt;Transformers&gt;(transform_ops)...);</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;}</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;}</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="acallable__traits_8h_html"><div class="ttname"><a href="callable__traits_8h.html">callable_traits.h</a></div></div>
<div class="ttc" id="aclassgrppi_1_1pipeline__t_html"><div class="ttname"><a href="classgrppi_1_1pipeline__t.html">grppi::pipeline_t</a></div><div class="ttdoc">Representation of pipeline pattern. Represents a pipeline with multiple chained transformers.</div><div class="ttdef"><b>Definition:</b> pipeline_pattern.h:30</div></div>
<div class="ttc" id="aexecution__traits_8h_html"><div class="ttname"><a href="execution__traits_8h.html">execution_traits.h</a></div></div>
<div class="ttc" id="agroup__pipeline__pattern_html_gaf3942c499118a951617b95c4ee10a502"><div class="ttname"><a href="group__pipeline__pattern.html#gaf3942c499118a951617b95c4ee10a502">grppi::pipeline</a></div><div class="ttdeci">void pipeline(const Execution &amp;ex, Generator &amp;&amp;generate_op, Transformers &amp;&amp;... transform_ops)</div><div class="ttdoc">Invoke Pipeline pattern on a data stream.</div><div class="ttdef"><b>Definition:</b> pipeline.h:46</div></div>
<div class="ttc" id="anamespacegrppi_html"><div class="ttname"><a href="namespacegrppi.html">grppi</a></div><div class="ttdef"><b>Definition:</b> callable_traits.h:21</div></div>
<div class="ttc" id="anamespacegrppi_html_ab781a9381060f18e9e5155a496e71aee"><div class="ttname"><a href="namespacegrppi.html#ab781a9381060f18e9e5155a496e71aee">grppi::supports_pipeline</a></div><div class="ttdeci">constexpr bool supports_pipeline()</div><div class="ttdoc">Determines if an execution policy supports the pipeline pattern.</div><div class="ttdef"><b>Definition:</b> execution_traits.h:78</div></div>
<div class="ttc" id="apipeline__pattern_8h_html"><div class="ttname"><a href="pipeline__pattern_8h.html">pipeline_pattern.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>
